GET api/list/events/filters?context={context}&eventTypes[0]={eventTypes[0]}&eventTypes[1]={eventTypes[1]}&roleTypes[0]={roleTypes[0]}&roleTypes[1]={roleTypes[1]}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| context | Dezrez.Core.DataContracts.External.Api.Lists.Events.ListContext |
Required |
|
| eventTypes | Collection of string |
None. |
|
| roleTypes | Collection of string |
None. |
Body Parameters
None.
Response Information
Resource Description
PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Lists.Events.Filter.EventListFilterDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalCount | integer |
None. |
|
| CurrentCount | integer |
None. |
|
| PageSize | integer |
None. |
|
| PageNumber | integer |
None. |
|
| Collection | Collection of Dezrez.Core.DataContracts.External.Api.Lists.Events.Filter.EventListFilterDataContract |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalCount": 1,
"CurrentCount": 2,
"PageSize": 1,
"PageNumber": 1,
"Collection": [
{
"CreatedBy": [
1,
2
],
"NegotiatorIds": [
1,
1
],
"OwningTeamIds": [
1,
1
],
"RoleIds": [
1,
2
],
"GroupId": 1,
"From": "2024-05-08T13:19:18.4935994Z",
"To": "2024-05-08T13:19:18.4935994Z",
"Date": {
"FromStaticDate": "2024-05-08T13:19:18.4935994Z",
"ToStaticDate": "2024-05-08T13:19:18.4935994Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"UpcomingOnly": true,
"CreatedFrom": "2024-05-08T13:19:18.4935994Z",
"CreatedTo": "2024-05-08T13:19:18.4935994Z",
"Created": {
"FromStaticDate": "2024-05-08T13:19:18.4935994Z",
"ToStaticDate": "2024-05-08T13:19:18.4935994Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"OfferStatuses": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"EventCategories": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"EventTypes": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"EventStatuses": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"IncludeDrafts": true,
"IncludeOnlyOriginalNotes": true,
"ExcludedRevisedOffers": true,
"ExcludedTypes": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"RoleTypes": [
"sample string 1",
"sample string 2"
],
"ExcludeRoleTypes": [
"sample string 1",
"sample string 2"
],
"RoleStatuses": [
"sample string 1",
"sample string 2"
],
"PropertyId": 1,
"Descriptions": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"FeedbackTaken": true,
"FeedbackReported": true,
"MethodsOfContact": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"SortType": 0,
"EventIds": [
1,
2
],
"AdditionalIds": [
1,
2
],
"ExcludedIds": [
1,
2
],
"CleanInactiveAppointments": true,
"UseMinimalMapping": true,
"FilterNotes": true,
"Name": "sample string 8",
"CustomFilterConfig": "sample string 9",
"BranchId": 1,
"BranchIds": [
1,
2
],
"EventBranchIds": [
1,
2
],
"Order": 0,
"SearchTerm": "sample string 10",
"FilterType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ShowDeleted": true,
"ShowCancelled": true,
"OwningTeamId": 13,
"Id": 14
},
{
"CreatedBy": [
1,
2
],
"NegotiatorIds": [
1,
1
],
"OwningTeamIds": [
1,
1
],
"RoleIds": [
1,
2
],
"GroupId": 1,
"From": "2024-05-08T13:19:18.4935994Z",
"To": "2024-05-08T13:19:18.4935994Z",
"Date": {
"FromStaticDate": "2024-05-08T13:19:18.4935994Z",
"ToStaticDate": "2024-05-08T13:19:18.4935994Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"UpcomingOnly": true,
"CreatedFrom": "2024-05-08T13:19:18.4935994Z",
"CreatedTo": "2024-05-08T13:19:18.4935994Z",
"Created": {
"FromStaticDate": "2024-05-08T13:19:18.4935994Z",
"ToStaticDate": "2024-05-08T13:19:18.4935994Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"OfferStatuses": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"EventCategories": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"EventTypes": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"EventStatuses": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"IncludeDrafts": true,
"IncludeOnlyOriginalNotes": true,
"ExcludedRevisedOffers": true,
"ExcludedTypes": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"RoleTypes": [
"sample string 1",
"sample string 2"
],
"ExcludeRoleTypes": [
"sample string 1",
"sample string 2"
],
"RoleStatuses": [
"sample string 1",
"sample string 2"
],
"PropertyId": 1,
"Descriptions": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"FeedbackTaken": true,
"FeedbackReported": true,
"MethodsOfContact": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"SortType": 0,
"EventIds": [
1,
2
],
"AdditionalIds": [
1,
2
],
"ExcludedIds": [
1,
2
],
"CleanInactiveAppointments": true,
"UseMinimalMapping": true,
"FilterNotes": true,
"Name": "sample string 8",
"CustomFilterConfig": "sample string 9",
"BranchId": 1,
"BranchIds": [
1,
2
],
"EventBranchIds": [
1,
2
],
"Order": 0,
"SearchTerm": "sample string 10",
"FilterType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ShowDeleted": true,
"ShowCancelled": true,
"OwningTeamId": 13,
"Id": 14
}
]
}